home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1102.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.2 KB  |  131 lines
  1. 16
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. ReadIni 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh.
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baReadIni gets a string from a Windows style ini file.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baReadIni( Section, Keyname, Default, IniFile )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String, String, String, String. 
  36. --- RECORDSEPARATOR ---
  37. Section is the section name of the ini file. 
  38. --- RECORDSEPARATOR ---
  39. Keyname is the name of the key 
  40. --- RECORDSEPARATOR ---
  41. Default is the string that is returned if the file, section or key doesn't exist. 
  42. --- RECORDSEPARATOR ---
  43. IniFile is the name if the ini file to use.
  44. --- RECORDSEPARATOR ---
  45.  
  46. --- RECORDSEPARATOR ---
  47. Returns:
  48. --- RECORDSEPARATOR ---
  49.  
  50. --- RECORDSEPARATOR ---
  51. String. 
  52. --- RECORDSEPARATOR ---
  53. Returns the value associated with the Keyname. If the IniFile, Section or Keyname 
  54. --- RECORDSEPARATOR ---
  55. doesn't exist, then the return will be the Default string.
  56. --- RECORDSEPARATOR ---
  57.  
  58. --- RECORDSEPARATOR ---
  59. Examples:
  60. --- RECORDSEPARATOR ---
  61.  
  62. --- RECORDSEPARATOR ---
  63. Director: 
  64. --- RECORDSEPARATOR ---
  65. set Name = baReadIni( "CurrentUser", "UserName", "Error", "Userdat.ini" ) 
  66. --- RECORDSEPARATOR ---
  67. Authorware: 
  68. --- RECORDSEPARATOR ---
  69. Name := baReadIni( "CurrentUser", "UserName", "Error", "Userdat.ini" )
  70. --- RECORDSEPARATOR ---
  71.  
  72. --- RECORDSEPARATOR ---
  73. Notes:
  74. --- RECORDSEPARATOR ---
  75.  
  76. --- RECORDSEPARATOR ---
  77. An entry in a Windows ini file has the following format : 
  78. --- RECORDSEPARATOR ---
  79. [Section] 
  80. --- RECORDSEPARATOR ---
  81. Keyname=string 
  82. --- RECORDSEPARATOR ---
  83. This function will return the string after the equals sign. When using this function, 
  84. --- RECORDSEPARATOR ---
  85. the Section name you use should not include the square brackets around the 
  86. --- RECORDSEPARATOR ---
  87. name. The Keyname should not include the equals sign. For example the ini file for 
  88. --- RECORDSEPARATOR ---
  89. the example above might look something like this 
  90. --- RECORDSEPARATOR ---
  91. [CurrentUser] 
  92. --- RECORDSEPARATOR ---
  93. UserName=Gary Smith 
  94. --- RECORDSEPARATOR ---
  95. Password=mypw 
  96. --- RECORDSEPARATOR ---
  97. ModulesCompleted=4 
  98. --- RECORDSEPARATOR ---
  99. The IniFile can be in any directory. On
  100. --- RECORDSEPARATOR ---
  101.  Windows
  102. --- RECORDSEPARATOR ---
  103. , if the full path is not specified the 
  104. --- RECORDSEPARATOR ---
  105. file will be assumed to be in the Windows directory, on the
  106. --- RECORDSEPARATOR ---
  107.  Macintosh
  108. --- RECORDSEPARATOR ---
  109.  it will be 
  110. --- RECORDSEPARATOR ---
  111. assumed to be in the Preferences folder. 
  112. --- RECORDSEPARATOR ---
  113. The ini file does not have to have an .ini extension: any extension can be used. 
  114. --- RECORDSEPARATOR ---
  115. This function returns a maximum of 
  116. --- RECORDSEPARATOR ---
  117. 32000 characters.
  118. --- RECORDSEPARATOR ---
  119.  
  120. --- RECORDSEPARATOR ---
  121. See also:
  122. --- RECORDSEPARATOR ---
  123.  
  124. --- RECORDSEPARATOR ---
  125. baWriteIni 
  126. --- RECORDSEPARATOR ---
  127. baFlushIni 
  128. --- RECORDSEPARATOR ---
  129. baDeleteIniEntry 
  130. --- RECORDSEPARATOR ---
  131. baDeleteIniSection